home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / hiroll48.zip / HIROLL.DOC < prev    next >
Text File  |  1992-12-25  |  23KB  |  495 lines
  1.  
  2.                              HIROLL   DICE
  3.  
  4.                                   v4.8
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    HIROLL DICE is a fast-paced board game in which you remove number
  21.    combinations from the board based upon the roll of the dice.
  22.  
  23.  
  24.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  25.          created in the directory you run the door from.
  26.  
  27.  
  28.  
  29.                               INSTALLATION
  30.                               ____________
  31.  
  32.  
  33.    Installation is fairly easy and straight-forward. The following steps and
  34.    examples should have you up and running in a very short period of time.
  35.    It is assumed that you are familiar with setting up DOORS on your system.
  36.    To this end, only examples of the configuration file and Door batch file
  37.    are described.
  38.  
  39.       1) Create a directory to hold all HIROLL files
  40.  
  41.       2) Unzip HIROLLxx.ZIP into the the above directory
  42.  
  43.       3) Create a configuration file, with a name of your choice, or
  44.          modify the supplied HIROLL.CFG file. A description follows:
  45.  
  46.             **                       Location of system file (See Below)
  47.             SUNRISE-80 BBS           Your BBS Name
  48.             Al                       Sysop's First name
  49.  
  50.             Lawrence                 Sysop's Last Name
  51.  
  52. |-----------------------------------------------------------------------------|
  53. | READ!     1                        CommPort  \ These 2 lines are required   |
  54. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  55. |-----------------------------------------------------------------------------|
  56.  
  57.             00000000                 Registration Number
  58.  
  59.    !    #   1                        Maximum # of Games per day
  60.                                      (Sysop gets 99 in Registered version ONLY!)
  61.  
  62.         #   0                        Max # of days a caller can make up, during
  63.                                      calls in one day. 0=Disable Make-up Option
  64.                                      Maximum value = 27, Minimum value = 1
  65.  
  66.         #   NONE                     Drive:\Path\Filename to contain the
  67.                                      Top Score Bulletin or enter NONE
  68.                                      for NO Bulletin creation.
  69.  
  70.         #   NONE                     Drive:\Path\Filename to contain the
  71.                                      Top Score Bulletin (Color) or enter NONE
  72.                                      for NO Bulletin creation.
  73.         #   NONE                     Drive:\Path\Filename to contain the
  74.                                      Hall of Fame Bulletin or enter NONE
  75.                                      for NO Bulletin creation.
  76.  
  77.         #   NONE                     Drive:\Path\Filename to contain the
  78.                                      Hall of Fame Bulletin (Color) or enter NONE
  79.                                      for NO Bulletin creation.
  80.  
  81.  
  82.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  83.                                      2 = Display ADOPT-A-DOOR message
  84.  
  85.         #   2                        Keyboard timeout value in Minutes
  86.  
  87.         #   50                   Pts to Deduct if HiScore >   100 & <   500
  88.         #   100                              "            >   499 & <  1000
  89.         #   300                              "            >   999 & <  4999
  90.         #   1000                             "            >  4999 & < 10000
  91.         #   2000                             "            >  9999 & < 20000
  92.         #   3000                             "            > 19999 & < 30000
  93.         #   5000                             "            > 29999 & < 40000
  94.         #   7000                             "            > 39999 & < 50000
  95.         #   9000                             "            > 49999 & < 60000
  96.         #   10000                            "            > 59999 & < 70000
  97.         #   15000                            "            > 69999
  98.     !   #   0                        Time Allowed in Door
  99.                                      (Sysop = Time Remaining - REG. VERSION)
  100.  
  101.         #   N                        Automatic game reset at end of month:
  102.                                        Y = Yes enable autoreset
  103.                                        N = Keep accumulating scores
  104.  
  105.         #   Y                        Y = Allow Sysop to have 999 games
  106.                                      N = Do Not Allow Sysop 999 games
  107.  
  108.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  109.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  110.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  111.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  112.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  113.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  114.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  115.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  116.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  117.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  118.  
  119.     @   #   XXXX/YYYY                 Blackout Range  From/To
  120.     @   #   XXXX/YYYY                 Blackout Range  From/To
  121.     @   #   XXXX/YYYY                 Blackout Range  From/To
  122.     @   #   XXXX/YYYY                 Blackout Range  From/To
  123.     @   #   XXXX/YYYY                 Blackout Range  From/To
  124.  
  125.           ** = Replace with ONE of the following:
  126.  
  127. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  128. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  129. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  130.                                    (Note:DOOR.SYS must be in SAME directory)
  131. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  132. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  133. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  134. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  135. C:\BBS\CHAIN.TXT                <- For WWIV systems
  136. C:\BBS\GTUSER.BBS               <- For GT Power
  137.                                    * if using this option you must put the
  138.                                      ComPort # on line 5 and the Node # on
  139.                                      line 6 of the configuration file
  140.  
  141.  
  142.            # = Requires registration to change to a different value.
  143.            ! = See "Plays Per Day/Door Time" Below
  144.            @ = See "Blackout Periods" Below
  145.  
  146.                NOTE: There are NO Blank Lines in the Config File!!
  147.  
  148.  
  149.       4) Create a batch file or modify the HIROLL file supplied. A
  150.          description of this file follows:
  151.  
  152.             ECHO off
  153.             cd\BBS\DOORS\HIROLL       Location of Hiroll files
  154.             HIROLL HIROLL.CFG         EXE filename and CFG filename (Name
  155.                                       used in creating file in #3 above)
  156.             CD\BBS
  157.             BOARD
  158.  
  159.  
  160.        5) When running in more than one node, be sure to supply a
  161.           different configuration name for each node (your choice of name).
  162.  
  163.        6) If running with   Fossil-based multi-port boards add
  164.            /FD to the line containing the CFG name as follows:
  165.  
  166.                           HIROLL HIROLL.CFG  /FD
  167.  
  168.  
  169.  
  170.                             POOL Points
  171.                             ------------
  172.  
  173. When you end up losing points, Hiroll will place them into a "POOL". This
  174. "POOL" will continue to accumulate all points lost by any player. It will
  175. also accumulate the points lost by those playing on any other node(s) at the
  176. same time. The "POOL" points will be updated on the players screen REAL TIME
  177. (at the moment the player on another node loses points). The "POOL" points
  178. can be won by any player, if they remove all the numbers in the BONUS round.
  179. Prior versions awarded a 5000 bonus if you cleared all the BONUS numbers. The
  180. minimum amount in the "POOL" will be 1000 points.
  181.  
  182.  
  183.  
  184.                MAKE-UP DAYS (Registered version only)
  185.                --------------------------------------
  186.  
  187. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  188. during the current month and prior to the current call. You control whether
  189. to allow this option, as well as the number of days the caller can make up, on
  190. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  191. configuration file, turns the option OFF, any other value (up to a max of 27)
  192. turns the option ON and dictates the number of days the caller can make up.
  193.  
  194.  
  195. NOTE:      The number of games per day is calculated as follows...
  196.  
  197.            Games Allowed per day x Number of makeup days.
  198.  
  199. Example:   Games Allowed per day = 2
  200.            Max # of makeup days  = 4
  201.  
  202. If a caller logs in on 5/8/92 and this is their first call of the month, they
  203. would have a potential of 16 games to makeup and bring them current
  204. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  205. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  206. (games allowed * max # of makeup days).
  207.  
  208.  
  209.  
  210.              HALL OF FAME BULLETINS (Registered version only)
  211.              ------------------------------------------------
  212.  
  213. The program will automatically reset the game when the first caller of the
  214. month plays the game. The score file will be cleared and a set of Hall of Fame
  215. bulletin files will be created. The files will be called SUNHOF.ASC and
  216. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  217. directory as the BETSY.EXE file. You are responsible for COPYING the files to
  218. your bulletin area and renaming to a filename of your choice.
  219.  
  220. WARNING: The HOF files are cumulative files. That means they are read in each
  221.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  222.          the record of prior months winners!!!!
  223.  
  224.  
  225.  
  226.                           BLACKOUT PERIODS
  227.                           ________________
  228.  
  229.       Use the Blackout ranges option to define up to 5 time periods during
  230.       which you DO NOT want the Door to be played. If a caller tries to access
  231.       the Door during the Blackout period, they will be shown a message that
  232.       contains ALL the Blackout periods you have defined, and to try the Door
  233.       at a later time.
  234.  
  235.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  236.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  237.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  238.  
  239.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  240.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  241.                    a Blackout range.
  242.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  243.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  244.  
  245.        NOTE: The deduction values, above, are the default values. The pgm
  246.              will check each value to ensure that it is equal to or greater
  247.              than the prior value. If it fails the check default values will
  248.              be used. If you do change the default values it will be your
  249.              reponsibility to edit the HIROLL.INS file and change the
  250.              deduction table contained within.
  251.  
  252.  
  253.                           PLAYS Per DAY/DOOR Time
  254.                           _______________________
  255.  
  256.       Plays Per Day and Door Time can be controlled several ways:
  257.  
  258.       (1) You can use the Games Per Day, singular option, in the config
  259.           file above. This option, will affect ALL callers whose Security
  260.           Level is NOT defined in any of the 10 optional Security Level/
  261.           Plays Per Day entries in the config file.
  262.  
  263.       (2) You can use the Door Time, singular option, in the config file
  264.           above. This option, will affect ALL callers whose Security
  265.           Level is NOT defined in any of the 10 optional Security Level/
  266.           Plays Per Day/Door Time entries in the config file.
  267.  
  268.       (3) You can restrict the number of games a specific Security Level
  269.           will be allowed to play per day or REWARD specific Levels with
  270.           more Plays Per Day.
  271.  
  272.           Likewise, you can restrict the Play time for a specific Security
  273.           Level or REWARD specific Levels with more Door Time.
  274.  
  275.           These options are handled by the use of the 10 config
  276.           entries (000=00/00).
  277.  
  278.           The format of each entry is as follows:
  279.  
  280.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  281.                      where =  is a constant and MUST be included
  282.                      where YY is the # of games per day (must be 2 digits)
  283.                      where / is a constant and MUST be included
  284.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  285.  
  286.           If the callers Security Level is NOT defined, his/her Plays Per
  287.           Day and Door Time will be controlled by the values in items
  288.           (1) and (2), above, respectively..
  289.  
  290.           You may define up to 10 Security Levels. All unused entries must
  291.           be defined as   00=00/00
  292.         --------------------------------------------------------------------
  293.           Example: Suppose you had 3 Security Levels defined on your BBS as
  294.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  295.           wanted to set Plays Per Day as :     Subscriber=5
  296.                                            Visiting Sysop=2
  297.                                                   CoSysop=3
  298.                                                    Friend=10
  299.  
  300.           and Door Time as follows:     Subscriber=30 minutes
  301.                                     Visiting Sysop=20 minutes
  302.                                            CoSysop=10 minutes
  303.                                             Friend=remaining call time
  304.  
  305.  
  306.           You would set the Individual "Games per Day" config entry to 1 and
  307.           the individual "Door Time" to 5 minutes (these would be the
  308.           default number of games and default Time for all Security Levels
  309.           other than 20,30 or 40... make them any number you want). Next you
  310.           would replace 4 of the Security Level entries as :  020=05/30
  311.                                                               030=02/20
  312.                                                               040=03/10
  313.                                                               090=10/0
  314.  
  315.  
  316.  
  317.                         NON-STANDARD COM SUPPORT
  318.                         ________________________
  319.  
  320.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  321.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  322.       number after the configuration filename. Let's assume your Door is
  323.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  324.       passed to your Door would be:
  325.  
  326.                             FOOBAR FOOBAR.CFG /5
  327.  
  328.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  329.       normally used with COM1. No /x parameter is needed for the standard
  330.       IRQ's.
  331.  
  332.       As an alternative, you may use an environmental variable on the command
  333.       line. To use the variable (following the example above), place a
  334.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  335.       different IRQ number for each node). The command line would now look
  336.       like this:
  337.  
  338.                           FOOBAR FOOBAR.CFG /%IRQ%
  339.  
  340.       This, in combination with the use of the environmental variables
  341.       described in the MULTI-NODE SETUP section will allow you to use one
  342.       batch file and one config file to run this door on all nodes.
  343.  
  344.  
  345.  
  346.  
  347.                            MULTI-NODE SETUP
  348.                            ________________
  349.  
  350.       All Sunrise Doors are Multi-Node capable. Each node must have the
  351.       ability to access a configuration file which will have its own system
  352.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  353.       line. There are 2 ways to accomplish this:
  354.  
  355.       (1) Create a separate configuration file for each node. The only
  356.           difference between each file would be the location of the system
  357.           file for that particular node. For example, on my system there are 2
  358.           nodes and the first line of the config files would look like this:
  359.  
  360.                         NODE1:  H:\PCB1\DOOR.SYS
  361.                         NODE2:  H:\PCB2\DOOR.SYS
  362.  
  363.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  364.  
  365.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  366.           the following PCBoard environmental variables:
  367.  
  368.                  PCBDIR    (Directory containing the System file)
  369.                  PCBDRIVE  (Drive containing the System file)
  370.  
  371.           Thus, the first line of the SINGLE configuration file, for this Door
  372.           would look like this:
  373.  
  374.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  375.  
  376.       NOTE: This option, as described, assumes that you are running PCBoard
  377.             14.5a software. The environmental variables are automatically
  378.             created by the software for each node.
  379.  
  380.             HOWEVER, if you are running other BBS software you should be able
  381.             to set the variables EXACTLY as described below, for EACH node
  382.             (more than likely in each batch file you use to bring up EACH node):
  383.  
  384.                             PCBDRIVE=C:
  385.                             ^^^^^^^^^
  386.                             PCBDIR=\NODE2
  387.                             ^^^^^^^^
  388.  
  389.             Info with a carat (^) under it, MUST be typed as is. The rest
  390.             depends on your naming conventions.
  391.  
  392.             This, in combination with the use of the optional environmental
  393.             variable described in the NON-STANDARD COM SUPPORT section, will
  394.             allow you to use one batch file and one config file to run this
  395.             door on all nodes.
  396.  
  397.  
  398.                                ADOPT-A-DOOR
  399.                                ____________
  400.  
  401.     Having been a Sysop for a number of years, I have had my share of problems
  402.     and frustrations getting financial support for my board's upkeep. A fellow
  403.     Sysop left a message on my board, not long ago, about a concept that was
  404.     being used by several boards around the country.
  405.  
  406.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  407.     would be the same as sending in a donation, only this way it is earmarked
  408.     for registering a particular door. In a way, the user feels he/she is
  409.     "getting something in return". As a Door author I have decided to build
  410.     this concept into each of my Door programs. The concept replaces the
  411.     usual message "tell the Sysop to register this Door" we find in most
  412.     doors.
  413.  
  414.     If the Door is unregisterd then a message appears on the opening screen
  415.     to that effect. After finishing or suspending a game, a message screen
  416.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  417.     caller to contact the Sysop to find out if there is any further details
  418.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  419.     time, etc to callers that ADOPT-A-DOOR.
  420.  
  421.     If the Door has been registered, either by the Sysop or other callers,
  422.     the names of those contributors will be displayed in the closing screen.
  423.  
  424.     NOTE: If you want to display the names of the callers that contributed
  425.           to registering the Door, you must create an ASCII file called
  426.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  427.           the name(s) of the contributors (one on each line, maximum of 5
  428.           entries, each a maximum of 30 characters long). This file must be
  429.           saved, in ASCII format, and placed in the Door directory.
  430.  
  431.  
  432.  
  433.                               LEGALITIES
  434.                               __________
  435.  
  436.  
  437.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  438.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  439.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  440.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  441.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  442.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  443.       OR BREACH OF ANY WARRANTY.
  444.  
  445.  
  446.  
  447.  
  448.  
  449.                              DISTRIBUTION
  450.                              ____________
  451.  
  452.    You may make this file available for downloading from your BBS or you may
  453.    upload it to any BBS of your choice, provided that you do not make any
  454.    changes to the contents of the archive (ZIP file). The archive and its
  455.    individual contents may not be used by any service that charges any money
  456.    whatsoever, without the written permission of the author.
  457.  
  458.  
  459.  
  460.  
  461.  
  462.                              REGISTRATION
  463.                              ____________
  464.  
  465.    Registration and the subsequent insertion of the registration number into
  466.    your configuation file, allows for the display of your BBS name on the
  467.    opening and closing screen as well as the reduction of a delay built into
  468.    the opening screen display along with the ability to change certain
  469.    values in the configuration file.
  470.  
  471.    To register your copy of HIROLL, please fill out the registration form
  472.    (REGISTER.FRM) and mail it along with the registration fee to
  473.    the name and address on the form.
  474.  
  475.    Be sure to use the proper upper/lower case when filling in your name and
  476.    BBS name, as they MUST match the way you entered them in the configuration
  477.    file.             ^^^^
  478.  
  479.    Based upon information supplied on the registration form, I will pre-
  480.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  481.    up your registration number.
  482.  
  483.  
  484.  
  485.                                  MISC
  486.                                  ____
  487.  
  488.    The latest version of HIROLL DICE and other fine SUNRISE DOOR programs
  489.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  490.  
  491.    Remember, should you have any problems, questions or suggestions, be sure
  492.    to drop me a message on either of the aforementioned BBS', SmartNet (Sysops)
  493.    Rime (PCBhints, Common, Doors, Sysops) or FidoNet 1:133/410
  494.  
  495.